// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//

#ifndef GeomAlgoAPI_FaceBuilder_H_
#define GeomAlgoAPI_FaceBuilder_H_

#include "GeomAlgoAPI.h"

#include <memory>

class GeomAPI_Dir;
class GeomAPI_Face;
class GeomAPI_Pln;
class GeomAPI_Pnt;
class GeomAPI_Vertex;
class gp_Ax3;

/// \class GeomAlgoAPI_FaceBuilder
/// \ingroup DataAlgo
/// \brief Allows to create face-shapes by different parameters
class GEOMALGOAPI_EXPORT GeomAlgoAPI_FaceBuilder
{
 public:
  /// Creates square planar face by given point of the center,
  /// normal to the plane and size of square.
  static std::shared_ptr<GeomAPI_Face> squareFace(const std::shared_ptr<GeomAPI_Pnt> theCenter,
                                                  const std::shared_ptr<GeomAPI_Dir> theNormal,
                                                  const double theSize);
  /// Creates square planar face by given point of the center,
  /// normal to the plane and size of square.
  static std::shared_ptr<GeomAPI_Face> squareFace(const std::shared_ptr<GeomAPI_Pln> thePlane,
                                                  const double theSize);

  /// Creates the planar face by given point of the center and normal to the plane.
  static std::shared_ptr<GeomAPI_Face> planarFace(const std::shared_ptr<GeomAPI_Pnt> theCenter,
                                                  const std::shared_ptr<GeomAPI_Dir> theNormal);

  /// Creates a planar face by given plane, left lower point and size. Does not take into account X & Y directions of thePlane!
  static std::shared_ptr<GeomAPI_Face> planarFace(const std::shared_ptr<GeomAPI_Pln> thePlane,
                                                  const double theX, const double theY,
                                                  const double theWidth, const double theHeight);

  /*! \brief Creates rectangular planar face, with normal, X and Y directions as of theCS. */
  static std::shared_ptr<GeomAPI_Face> planarRectangularFace(
    const gp_Ax3& theCS,
    double theWidth, double theHeight,
    double theOffsetX = 0, double theOffsetY = 0
  );

  /// Creates a planar face by three vertices.
  static std::shared_ptr<GeomAPI_Face> planarFaceByThreeVertices(
                        const std::shared_ptr<GeomAPI_Vertex> theVertex1,
                        const std::shared_ptr<GeomAPI_Vertex> theVertex2,
                        const std::shared_ptr<GeomAPI_Vertex> theVertex3);
};

#endif
